react-fontawesome
Advanced tools
Readme
A React component for the font-awesome icon library.
If you are using Font Awesome v5+, please use the official React component!. react-fontawesome does not support FontAwesome v5!
npm install --save react-fontawesome
Note: This component does not include any of the Font Awesome CSS or fonts, so you'll need to make sure to include those on your end somehow, either by adding them to your build process or linking to CDN versions.
The fastest way to get started is to import FontAwesome with a link tag in your page's <head>:
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
You can change the version number to use whatever version of FontAwesome you'd like.
If you're using WebPack, you will need to install FontAwesome, import the FontAwesome Sass/Less, and configure the font path. Please see this blog post on how to get Webpack and FontAwesome working together.
var React = require('react')
var FA = require('react-fontawesome')
React.render(<FA name="rocket" />, document.body)
classNames, styles and other props (all additional props are passed directly to the component).Regular usage
var React = require('react')
var FontAwesome = require('react-fontawesome')
var MyComponent = React.createClass({
render: function() {
return (
<FontAwesome
className="super-crazy-colors"
name="rocket"
size="2x"
spin
style={{ textShadow: '0 1px 0 rgba(0, 0, 0, 0.1)' }}
/>
)
},
})
With the use of CSS Modules
import React from 'react'
import FontAwesome from 'react-fontawesome'
import faStyles from 'font-awesome/css/font-awesome.css'
var MyComponent = React.createClass({
render: function() {
return (
<FontAwesome
className="super-crazy-colors"
name="rocket"
cssModule={faStyles}
size="2x"
spin
style={{ textShadow: '0 1px 0 rgba(0, 0, 0, 0.1)' }}
/>
)
},
})
The above will create output like this:
<span class="font-awesome__fa___2otTb font-awesome__fa-rocket___lfSov font-awesome__super-crazy-colors___3k583"></span>
See the API docs for full documentation.
Pull requests welcome!
Run the test suite with npm test and format your code with npm run format. Make sure tests are passing and that you write tests for new features and document changes to the API with updates to the JSDocs.
Before you submit your pull request, run npm run dist to build the project and commit the changes.
FAQs
A React component for the font-awesome icon library.
The npm package react-fontawesome receives a total of 21,628 weekly downloads. As such, react-fontawesome popularity was classified as popular.
We found that react-fontawesome demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.